Skip to main content
POST
Create Location Profile

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

id
integer<int32>
required

The id of the referenced Warehouse.

Body

application/json

The body of a Location Profile create request. The warehouse comes from the path, and every other property of the resource — status, revisions, counts, timestamps — is derived by the server and cannot be submitted.

name
string
required

The profile name, which must be unique within the warehouse.

Required string length: 1 - 255
Example:

"Rack Pick Face"

match
LocationProfileMatchClauseInput · object[]
required

The ordered clauses defining membership, all of which must match.

Required, and deliberately so: an empty array means "every non-temporary location in the warehouse", which is the widest possible profile, so it has to be asked for rather than arrived at by leaving a field out. A definition accepts at most 64 clauses, 250 values per clause, 1,000 values across all clauses, and 512 KiB of JSON.

Maximum array length: 64
Example:
description
string | null

An optional explanation of the locations represented by this profile.

Maximum string length: 16000
Example:

"Pickable shelf locations on rack aisles, excluding ground-level overflow."

Response

Accepted - The request was accepted and membership is being materialized. There is no response body. For a new profile, poll until status is ready. For an update or rebuild, successful publication is complete when pending_revision becomes null; a failed replacement remains present there with a failed status.